<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pyopenspime.protocol.extension.xmpp.pubkey.ReqObj</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pyopenspime/">PyOpenSpime v0.2</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;pyopenspime ::
        Package&nbsp;protocol ::
        Package&nbsp;extension ::
        Package&nbsp;xmpp ::
        <a href="pyopenspime.protocol.extension.xmpp.pubkey-module.html">Module&nbsp;pubkey</a> ::
        Class&nbsp;ReqObj
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pyopenspime.protocol.extension.xmpp.pubkey.ReqObj-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ReqObj</h1><p class="nomargin-top"><span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj">source&nbsp;code</a></span></p>
<p>PubKey XMPP Extension Request object.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyopenspime.protocol.extension.xmpp.pubkey.ReqObj-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">osid_pubkey</span>)</span><br />
      Initialize a PubKey XMPP Extension Request object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">pyopenspime.xmpp.simplexml.Node</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyopenspime.protocol.extension.xmpp.pubkey.ReqObj-class.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Builds the &lt;transport/&gt; node content of the data reporting 
      stanza.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.build">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">pyopenspime.xmpp.protocol.Iq</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyopenspime.protocol.extension.xmpp.pubkey.ReqObj-class.html#accepted" class="summary-sig-name">accepted</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Builds a response stanza to the PubKey request received</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.accepted">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">pyopenspime.xmpp.protocol.Iq</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyopenspime.protocol.extension.xmpp.pubkey.ReqObj-class.html#error" class="summary-sig-name">error</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">error_type</span>,
        <span class="summary-sig-arg">error_cond</span>,
        <span class="summary-sig-arg">error_namespace</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">error_description</span>=<span class="summary-sig-default">None</span>)</span><br />
      Builds a 'error' stanza according to the OpenSpime Data Reporting 
      protocol extension.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.error">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">osid_pubkey</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initialize a PubKey XMPP Extension Request object.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>osid_pubkey</code></strong> (str) - The requested pubkey's OSID.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="build"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.build">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Builds the &lt;transport/&gt; node content of the data reporting 
  stanza.</p>
  <dl class="fields">
    <dt>Returns: pyopenspime.xmpp.simplexml.Node</dt>
        <dd>The complete XMPP stanza to be sent out as request.</dd>
  </dl>
</td></tr></table>
</div>
<a name="accepted"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">accepted</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.accepted">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Builds a response stanza to the PubKey request received</p>
  <dl class="fields">
    <dt>Returns: pyopenspime.xmpp.protocol.Iq</dt>
        <dd>The Iq stanza to be sent out as confirmation message.</dd>
  </dl>
</td></tr></table>
</div>
<a name="error"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">error</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">error_type</span>,
        <span class="sig-arg">error_cond</span>,
        <span class="sig-arg">error_namespace</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">error_description</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pyopenspime.protocol.extension.xmpp.pubkey-pysrc.html#ReqObj.error">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Builds a 'error' stanza according to the OpenSpime Data Reporting 
  protocol extension.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>error_type</code></strong> (unicode) - The error type as defined by the XMPP protocol. Value MUST be:
          <p>'cancel' -- do not retry (the error is unrecoverable) 
          'continue' -- proceed (the condition was only a warning) 'modify'
          -- retry after changing the data sent 'auth' -- retry after 
          providing credentials 'wait' -- retry after waiting (the error is
          temporary).</p></li>
        <li><strong class="pname"><code>error_cond</code></strong> (unicode) - The error condition.</li>
        <li><strong class="pname"><code>error_namespace</code></strong> (unicode) - The error condition namespace.</li>
        <li><strong class="pname"><code>error_description</code></strong> (unicode) - The error description.</li>
    </ul></dd>
    <dt>Returns: pyopenspime.xmpp.protocol.Iq</dt>
        <dd>The Iq stanza to be sent out as error message.</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pyopenspime/">PyOpenSpime v0.2</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Dec 18 12:31:01 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
